package com.example.apidocserver.application.event;

import com.example.apidocserver.domain.document.entity.ApiInfo;
import com.example.apidocserver.domain.document.entity.ApiParam;
import com.example.apidocserver.domain.document.entity.ApiParamHis;
import com.example.apidocserver.interfaces.vo.ApiInfoAllVo;

import java.util.List;

/**
 * 接口相关处理事件
 *
 * @author xyqlg
 */
public interface ApiEvent {
    /**
     * 查询接口信息
     *
     * @param apiId     接口id
     * @param envId     环境id
     * @param writeFlag 是否为编辑查询
     * @return 接口信息
     */
    ApiInfoAllVo getApiInfo(Integer apiId, Integer envId, boolean writeFlag);

    /**
     * 新增或修改接口示例对象
     *
     * @param apiParamHis 示例对象
     * @param addRltFlag  参数是否绑定字段说明
     * @return 示例对象
     */
    ApiInfoAllVo upsertParamHis(ApiParamHis apiParamHis, boolean addRltFlag);

    /**
     * 增加或修改参数说明
     *
     * @param paramDescVo 参数说明信息
     * @return 参数说明信息
     */
    ApiParam upsertParamDesc(ApiParam paramDescVo);

    /**
     * 新增或修改接口信息
     *
     * @param apiInfo 接口信息
     * @return 接口信息
     */
    ApiInfo upsertApiInfo(ApiInfo apiInfo);

    /**
     * 根据接口名称或者接口路由查询接口信息
     *
     * @param apiInfo 查询信息
     * @param docId   文档id
     * @return 接口信息集合
     */
    List<ApiInfo> findApiLike(ApiInfo apiInfo, Integer docId);

    /**
     * 查询工作空间下所有接口信息
     *
     * @param spaceId 接口id
     * @return 接口信息集合
     */
    List<ApiInfo> findAllBySpaceId(Integer spaceId);
}
